home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / fms110.arc / FMS.DOC < prev    next >
Encoding:
Text File  |  1991-02-09  |  17.6 KB  |  324 lines
  1.                              ┌───────┐
  2.                              │ ┌─────┘
  3.                              │ │    ┌─┐┌─┐┌─────┐
  4.                              │ └───┐└─┘│ ││ ┌───┘
  5.                              │ ┌───┘┌─┐│ ││ └─┐
  6.                              │ │    │ ││ ││ ┌─┘
  7.      ┌─────────┐             │ │    │ ││ ││ └───┐
  8.      │ ┌─┐ ┌─┐ │             └─┘    └─┘└─┘└─────┘
  9.      │ │ │ │ │ │┌─────┐┌─────┐┌─┐┌─────┐┌─────┐┌─────┐┌─┐┌─────┐┌─────┐
  10.      │ │ │ │ │ ││ ┌─┐ ││ ┌─┐ │└─┘└─┐ ┌─┘│ ┌─┐ ││ ┌─┐ │└─┘│ ┌─┐ ││ ┌─┐ │
  11.      │ │ │ │ │ ││ │ │ ││ │ │ │┌─┐  │ │  │ │ │ ││ │ └─┘┌─┐│ │ │ ││ │ │ │
  12.      │ │ │ │ │ ││ │ │ ││ │ │ ││ │  │ │  │ │ │ ││ │    │ ││ │ │ ││ │ │ │
  13.      │ │ │ │ │ ││ └─┘ ││ │ │ ││ │  │ │  │ └─┘ ││ │    │ ││ │ │ ││ └─┘ │
  14.      └─┘ └─┘ └─┘└─────┘└─┘ └─┘└─┘  └─┘  └─────┘└─┘    └─┘└─┘ └─┘└───┐ │
  15.              ┌──────────────────────────────────────────────────────┘ │
  16.              │ ┌──────────────────────────────────────────────────────┘
  17.              │ │       ┌─┐ ┌─┐┌──────┐┌─────┐┌─────┐┌─────────┐
  18.              │ └──────┐│ │ │ ││ ┌────┘└─┐ ┌─┘│ ┌───┘│ ┌─┐ ┌─┐ │
  19.              └──────┐ ││ │ │ ││ └────┐  │ │  │ └─┐  │ │ │ │ │ │
  20.                     │ ││ │ │ │└────┐ │  │ │  │ ┌─┘  │ │ │ │ │ │
  21.              ┌──────┘ ││ └─┘ │┌────┘ │  │ │  │ └───┐│ │ │ │ │ │
  22.              └────────┘└───┐ │└──────┘  └─┘  └─────┘└─┘ └─┘ └─┘
  23.                        ┌───┘ │ Release Version 1.10
  24.                        └─────┘
  25.  
  26.                   ░░░▒▒▒▓▓▓███  LEGAL STUFF:  ███▓▓▓▒▒▒░░░
  27.  
  28.   Let's hurry up and get this out of the way.  By running this program, you
  29.   are exempting me, Mike Smith, of any and all damage this program might or
  30.   has caused.  I myself have went to great pains to prevent any damage that
  31.   this program could cause.  If this program opens a file that did not come
  32.   with this package, that file is opened for READ ONLY, and, will not write
  33.   to such files.
  34.  
  35.   To date, I have run this program time and time again.  Some versions were
  36.   not acceptable even to the Beta team, however, the several of those which
  37.   are listed in BETA.DOC have encouraged me to release this, thus, it is as
  38.   complete as this particular version gets.
  39.  
  40.  
  41.            ░░░▒▒▒▓▓▓███  Credit Where Credit Is Due  ███▓▓▓▒▒▒░░░
  42.  
  43.   This section is simply to give credit to the programs and there author of
  44.   which this program was designed to work with.  They are:
  45.  
  46.               Front Door:                Joaquim H. Homrighausen
  47.               Remote Access:             Andrew Milner
  48.  
  49.   Thanks guys, this wouldn't exist if it weren't for you all, and besides,
  50.   users tend to like RA  around here, and the SysOp's, Front Door Rules!!!
  51.  
  52.                   ░░░▒▒▒▓▓▓███  What is FMS?  ███▓▓▓▒▒▒░░░
  53.  
  54.   Let me be brief here.  The original intent of this program was simply for
  55.   creating a log of the files I recieved.  I myself though that Front Door,
  56.   a great program by itself, was great, though, the log file was just a bit
  57.   on the large side.  I myself did not want to know that these bundles were
  58.   not sent, etc.  I was concerned soly about the files which come into this
  59.   system.  Thus, this program gained it's roots.
  60.  
  61.   Now days, it's slightly expanded.  It not only reads a FD 1.99c log file,
  62.   but, now reads FD 2.00 and RA 0.04 log files as well.  My original was as
  63.   crude as it gets, but, it worked.  I even completely re-wrote the code as
  64.   it was so hard to understand after about 3 revisions all using "Bad Code"
  65.   so to speak.  The original was all hard coded, and, little to no changing
  66.   was done outside the code itself.  Now, this program has grown to a nice,
  67.   yet managable, size with almost complete configurability.
  68.  
  69.                  ░░░▒▒▒▓▓▓███  Registration!:  ███▓▓▓▒▒▒░░░
  70.  
  71.   Like almost every program you see, this one likewise has it's own section
  72.   for "Registration".  What I ask in return for the use of this program you
  73.   should find most affordable.  Simply send me a portcard or letter telling
  74.   me your opinion of this program, any bug you have found, or something you
  75.   would like it to do (ie  Read some other type of log file).  I think that
  76.   that is fair, don't you?
  77.  
  78.   Also, for those of you that think this program is worth paying for, may I
  79.   simply state that as of this writting, I am currently out of work, and, I
  80.   would be very appriciative to those that offer me a few bucks.
  81.  
  82.   Please send any/all corespondance to:        Mike Smith
  83.                                                3110 Race St.
  84.                                                Jonesboro, Ar  72401
  85.                                                USA
  86.  
  87.               ░░░▒▒▒▓▓▓███  Running The Program:  ███▓▓▓▒▒▒░░░
  88.  
  89.   This part seems so simple to me, but, none the less, I feel I better use
  90.   up a little room in these doc's to show you all the possible ways that a
  91.   person can run this program.
  92.  
  93.   Without Passing A Parameter:
  94.   This program will, by default, look for a file called FMS.CTL within the
  95.   current directory if there were no command line parameters passed.  This
  96.   program will first check for the file FMS.CTL.  If it is not found, then
  97.   the program will exit on Errorlevel 1.  If the file file is found, then,
  98.   the the control file FMS.CTL will be read in, and, all commands there in
  99.   will be be processed BEFORE actual processing of the log file(s)
  100.  
  101.   Passing A Parameter:
  102.   The passing of a command line parameter to the program will allow you to
  103.   change the filename of the control file.  If you pass a parameter to the
  104.   program, this parameter will take the place of the default filename that
  105.   the program normally uses for the Control File name.  (ie  FMS.CTL)
  106.  
  107.   The first parameter MUST be the complete Path and filename.  However, as
  108.   you may expect, if the file is located within the current directory that
  109.   the program is ran from, only the filename is needed as the parameter.
  110.  
  111.   Example:
  112.   FMS                    <--    Looks in the current directory for FMS.CTL
  113.   FMS SAMPLE.CTL         <-- Looks in the current directory for SAMPLE.CTL
  114.   FMS C:\BBS\SAMPLE.CTL  <--  Looks in the C:\BBS directory for SAMPLE.CTL
  115.  
  116.                 ░░░▒▒▒▓▓▓███  The Control File:  ███▓▓▓▒▒▒░░░
  117.  
  118.   The control file is the brains of the program.  Without one, the program
  119.   will not know what to process.  By default, all log files to be used are
  120.   set to the off posistion.  You must define where the log(s) are, and, as
  121.   ussual, the log file name.
  122.  
  123.   Also note the program processes the entire control file BEFORE any other
  124.   processing of the other files is done.  Thus, two lines which define the
  125.   front door 1.99c log file will result in only the last line containing a
  126.   FD 1.99c log file entry being processed.
  127.  
  128.   Also, you need to use a semi-colon to mark the end of line.  Without the
  129.   semi-colon, I will not ensure success, but, I tried to prevent error but
  130.   I still HIGHLY recommend the semi-colon!  All data after this semi-colon
  131.   will be treated as a comment.  Also, you can place a semi-colon upon any
  132.   line by itself without an error occuring.
  133.  
  134.   The syntax of the control file is:
  135.   SYNTAX: [Key Word] [Data] ; [Comments go after the Semi-Colon]
  136.  
  137.   Examples:
  138.   FD-199C      C:\FD\FD.LOG          ; Process Front Door Log File
  139.   ra-004       c:\ra\ra.log          ; Process Remote Access Log File
  140.   rec-echo     off                   ; Do not process echomail packets
  141.   REC-NET      ON                    ; Process NetMail Packets
  142.   RCVD         C:\FD\FMS.LOG         ; Log File To Create/Add to
  143.   BBSNAME      The 8-Bit Wonderland! ; Name of your BBS
  144.  
  145.   Spaces prior to, the key word(s) shouldn't hurt.  Likewise, spaces which
  146.   serve only to allign the optional data shouldn't hurt either.  Notice, I
  147.   did not do this purely by accident.  This was done to keep it so that as
  148.   the file grew, you was still able to read it.
  149.  
  150.   Another thing to notice is that this is not picky about case.  In short,
  151.   I simply convert the line(s) into upper case.  This saved time, but more
  152.   importantly, prevented user errors.
  153.  
  154.                 ░░░▒▒▒▓▓▓███   Valid Key Words:  ███▓▓▓▒▒▒░░░
  155.  
  156.   FD-199C                                           Default Setting:  NONE
  157.   ────────────────────────────────────────────────────────────────────────
  158.   Purpose:  This key word is to allow the processing of a Front Door 1.99c
  159.             Log File.  All previous version of Front Door may work with it
  160.             enabled, but, do not count on it!  If the file isn't found, an
  161.             error code of 1 will be passed.
  162.   Data:     Complete Path And Filename To The Front Door 1.99c Log File
  163.  
  164.   FD-200                                            Default Setting:  NONE
  165.   ────────────────────────────────────────────────────────────────────────
  166.   Purpose:  This key word is to allow for the processing of the Front Door
  167.             2.00 log file(s).  This is EXCLUSIVELY for Front Door 2.00, as
  168.             all previous versions log information diferently.
  169.   Data:     Complete Path And Filename To The Front Door 2.00 Log File
  170.  
  171.   RA-004                                            Default Setting:  NONE
  172.   ────────────────────────────────────────────────────────────────────────
  173.   Purpose:  This key word allows for the processing of Remote Access 0.04.
  174.             I have not checked any prior versions of Remote Access, but, I
  175.             would love to know if it works on any log files generated from
  176.             versions 0.01 through 0.03.  Note, logging FREQ when this your
  177.             RA as a stand alone is unwise, as, no FREQ's will come from an
  178.             Remote Access Log file.
  179.   Data:     Complete Path And Filename To The Remote Access 0.04 Log File
  180.  
  181.   RCVD                                           Default Setting:  FMS.LOG
  182.   ────────────────────────────────────────────────────────────────────────
  183.   Purpose:  This key word defines the output log file to be generated with
  184.             this program.  All files that were sent to your BBS whether by
  185.             uploads from users, you file requesting, or, someone sending a
  186.             file to you are recorded in this log.  Default setting is that
  187.             of FMS.LOG.  Setting this to NONE allows you to turn this off.
  188.             Output is also effected by the following commands:
  189.  
  190.               o REC-ECHO      o REC-NET     o REC-SIZE
  191.               o REC-DATE      o REC-TIME    o REC-LOG
  192.               o REC-NODE      o REC-FROM    o REC-BBS
  193.  
  194.   Data:     Complete Path And Filename To The Recieved File Log
  195.   Note:     This command can have the same data as the SENT and/or FREQ so
  196.             to make the output as configurable as possible
  197.  
  198.   SENT                                              Default Setting:  NONE
  199.   ────────────────────────────────────────────────────────────────────────
  200.   Purpose:  This key word defines the output log file to be generated with
  201.             this program.  All files that were sent out from your computer
  202.             will be monitored here.  This includes the files you sent from
  203.             the result of a user downloading, you sending a file because a
  204.             person did a file request, or because you wanted the file sent
  205.             Output is also effected by the following commands:
  206.  
  207.               o REC-ECHO      o REC-NET     o REC-SIZE
  208.               o REC-DATE      o REC-TIME    o REC-LOG
  209.               o REC-NODE      o REC-FROM    o REC-BBS
  210.  
  211.   Data:     Complete Path And Filename To The Recieved File Log
  212.   Note:     This command can have the same data as the RCVD and/or FREQ so
  213.             to make the output as configurable as possible
  214.  
  215.   FREQ                                              Default Setting:  NONE
  216.   ────────────────────────────────────────────────────────────────────────
  217.   Purpose:  This key word defines the output log file to be generated with
  218.             this program.  All request that come to your system will be in
  219.             this output file.  Notice, it does not show a file size for it
  220.             Output is also effected by the following commands:
  221.  
  222.               o REC-ECHO      o REC-NET     o REC-SIZE
  223.               o REC-DATE      o REC-TIME    o REC-LOG
  224.               o REC-NODE      o REC-FROM    o REC-BBS
  225.  
  226.   Data:     Complete Path And Filename To The Recieved File Log
  227.   Note:     This command can have the same data as the RCVD and/or SENT so
  228.             to make the output as configurable as possible
  229.  
  230.   DISPLAY                                             Default Setting:  ON
  231.   ────────────────────────────────────────────────────────────────────────
  232.   Purpose:  This is simply done for looks, and, keep you from thinking you
  233.             have just locked up your computer.  This is the only thing the
  234.             command is good for.  It does, however, slow the program down.
  235.   Data:     ON / OFF
  236.   Note:     Turning this off will increase speed by as much as 10% to 15%.
  237.  
  238.   REC-ECHO                                           Default Setting:  OFF
  239.   ────────────────────────────────────────────────────────────────────────
  240.   Purpose:  This key word allow you to toggle the logging of EchoMail.  As
  241.             a result, with this option off, all EchoMail Packets shouldn't
  242.             show up in the output file.
  243.   Data:     ON / OFF
  244.  
  245.   REC-NET                                            Default Setting:  OFF
  246.   ────────────────────────────────────────────────────────────────────────
  247.   Purpose:  This key word will either enable or disable logging of all Net
  248.             Mail packet that come in.  Note, with every EchoMail packet, a
  249.             NetMail packet will also come in as the echomail is sent using
  250.             a File Attach in a NetMail packet.
  251.   Data:     ON / OFF
  252.  
  253.   REC-NODE                                            Default Setting:  ON
  254.   ────────────────────────────────────────────────────────────────────────
  255.   Purpose:  This key word serves the purpose of adding a colum and logging
  256.             one of the following, depending on which log it was read from.
  257.               If read from FD log file:      Net Node Address
  258.               If read from RA log file:      Line The User Was On
  259.   Data:     ON / OFF
  260.                                                                       
  261.   REC-FROM                                           Default Setting:  OFF
  262.   ────────────────────────────────────────────────────────────────────────
  263.   Purpose:  This key word serves the purpose of adding a colum and logging
  264.             one of the following, depending on which log it was read from.
  265.               If read from FD log file:      SysOp Of The BBS
  266.               If read from RA log file:      User
  267.   Data:     ON / OFF
  268.  
  269.   REC-BBS                                            Default Setting:  OFF
  270.   ────────────────────────────────────────────────────────────────────────
  271.   Purpose:  This key word serves the purpose of adding a colum and logging
  272.             one of the following, depending on which log it was read from.
  273.               If read from FD log file:      The BBS Name
  274.               If read from RA log file:      Your BBS Name
  275.   Data:     ON / OFF
  276.  
  277.   REC-SIZE                                            Default Setting:  ON
  278.   ────────────────────────────────────────────────────────────────────────
  279.   Purpose:  This key word serves the purpose of adding a colum and logging
  280.             one of the following, depending on which log it was read from.
  281.               If read from FD log file:      File Size
  282.               If read from RA log file:      File Size
  283.   Data:     ON / OFF
  284.   Note:     Small file transfers (under 4 to 6 Kilobytes) Front Door won't
  285.             catch and log the file size.  Also, File Request NEVER records
  286.             the file sizes.  I can not confirm that Front Door 2.00 looses
  287.             the file size.  This is from observations with FD 1.99c
  288.  
  289.   REC-DATE                                            Default Setting:  ON
  290.   ────────────────────────────────────────────────────────────────────────
  291.   Purpose:  This key word serves the purpose of adding a colum and logging
  292.             one of the following, depending on which log it was read from.
  293.               If read from FD log file:      Transaction Date
  294.               If read from RA log file:      Transaction Date
  295.   Data:     ON / OFF
  296.  
  297.   REC-TIME                                            Default Setting:  ON
  298.   ────────────────────────────────────────────────────────────────────────
  299.   Purpose:  This key word serves the purpose of adding a colum and logging
  300.             one of the following, depending on which log it was read from.
  301.               If read from FD log file:      Transaction Time
  302.               If read from RA log file:      Transaction Time
  303.   Data:     ON / OFF
  304.  
  305.   REC-LOG                                             Default Setting:  ON
  306.   ────────────────────────────────────────────────────────────────────────
  307.   Purpose:  This key word serves the purpose of adding a colum and logging
  308.             one of the following, depending on which log it was read from.
  309.               If read from FD log file:      FD 200 or FD199C
  310.               If read from RA log file:      RA 004
  311.   Data:     ON / OFF
  312.  
  313.   BBSNAME                                       Default Setting:  This BBS
  314.   ────────────────────────────────────────────────────────────────────────
  315.   Purpose:  This is the last of the key words.  It is so that you might be
  316.             able define your BBS name.  You do not need to use anything to
  317.             divide the words (ie underscores, etc.) but this field is does
  318.             haave a limit of 40 charaacters or 5 Words (The smaller of the
  319.             two conditions is the limit).  This should only be placed into
  320.             the control file if you use the RA command.
  321.   Data:     BBS Name
  322.  
  323.   ════════════════════════[ End Of Documentation ]════════════════════════
  324.